<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>bn::regular_bg_map_ptr class | Butano Docs</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon-dark.png" type="image/png" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://github.com/GValiente/butano">Butano</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">Docs</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Pages</a></li>
            <li><a href="modules.html">Modules</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="namespaces.html">Namespaces</a></li>
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacebn.html">bn</a>::<wbr/></span>regular_bg_map_ptr <span class="m-thin">class</span>
          <div class="m-doc-include m-code m-inverted m-text-right"><span class="cp">#include</span> <a class="cpf" href="bn__regular__bg__map__ptr_8h.html">&lt;bn_regular_bg_map_ptr.h&gt;</a></div>
        </h1>
        <p>std::shared_ptr like smart pointer that retains shared ownership of a regular background map.</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#pub-static-methods">Public static functions</a></li>
                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
                <li><a href="#friends">Friends</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>Several <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> objects may own the same regular background.</p><p>The regular background map is released when the last remaining <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> owning it is destroyed.</p>
        <section id="pub-static-methods">
          <h2><a href="#pub-static-methods">Public static functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#a2d07bec8b450dd9be1cb3fad866b2c26" class="m-doc">find</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              const <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a>&amp; tiles,
              const <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>&amp; palette) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#afe2eaea1ee94a84f232bb51c47cfa8b3" class="m-doc">find</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              const <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a>&amp; tiles,
              const <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>&amp; palette,
              int map_index) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#abca117d5579fd9a773e3d746d6b5130d" class="m-doc">find</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#af3bb07f1f5c04d4e7559cc573b85503e" class="m-doc">find</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item,
              int map_index) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#a949acc3cde0d9f2f342e184b3a7a792b" class="m-doc">create</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette) -&gt; <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a></span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#ae3f7d88e00caa420a37354b4df7c2582" class="m-doc">create</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette,
              int map_index) -&gt; <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a></span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#a0c4e8b96ccb6fe80a9765a0ec66426bb" class="m-doc">create</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item) -&gt; <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a></span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#ab7bdc14b5331988d8a5edc4aa1f6d203" class="m-doc">create</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item,
              int map_index) -&gt; <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a></span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#aba98edb02f325a515ccf26a239e2dd40" class="m-doc">allocate</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1size.html" class="m-doc">size</a>&amp; dimensions,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette) -&gt; <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a></span>
            </dt>
            <dd>Creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references a chunk of VRAM map cells not visible on the screen.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#a8c3cd9fc0d26dda9d0220d704c62fa98" class="m-doc">create_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#af34582759a7f9095ffc7bdc0b60dc0ef" class="m-doc">create_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette,
              int map_index) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#aecd9c77e22050f9c37bb93a8c9a9f0d0" class="m-doc">create_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#aa542e8e72ae0cba7772ab519e58cb556" class="m-doc">create_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item,
              int map_index) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">static auto <a href="#af397abc18c118f0782d8fe9e1fc2c0aa" class="m-doc">allocate_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1size.html" class="m-doc">size</a>&amp; dimensions,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt;</span>
            </dt>
            <dd>Creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references a chunk of VRAM map cells not visible on the screen.</dd>
          </dl>
        </section>
        <section id="typeless-methods">
          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#aae88f5344ccf5e4322be0eda4b5e61b2" class="m-doc">regular_bg_map_ptr</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; other)</span>
            </dt>
            <dd>Copy constructor.</dd>
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#a937b2154b31edfdb959f971b8db5454f" class="m-doc">regular_bg_map_ptr</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp;&amp; other) <span class="m-label m-flat m-success">noexcept</span></span>
            </dt>
            <dd>Move constructor.</dd>
            <dt id="a1640c47dde2526f55a06886f36e42ccc">
              <span class="m-doc-wrap-bumper"><a href="#a1640c47dde2526f55a06886f36e42ccc" class="m-doc-self">~regular_bg_map_ptr</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>Releases the referenced map cells if no more <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> objects reference to them.</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#adfb755eed8e56315334d9603a490c1be" class="m-doc">operator=</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; other) -&gt; <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp;</span>
            </dt>
            <dd>Copy assignment operator.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#ab8b66a5272f649fd79e7821828d49a7f" class="m-doc">operator=</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp;&amp; other) -&gt; <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; <span class="m-label m-flat m-success">noexcept</span></span>
            </dt>
            <dd>Move assignment operator.</dd>
            <dt id="a31569b59e0d661e297b34c28eabda331">
              <span class="m-doc-wrap-bumper">auto <a href="#a31569b59e0d661e297b34c28eabda331" class="m-doc-self">id</a>(</span><span class="m-doc-wrap">) const -&gt; int</span>
            </dt>
            <dd>Returns the internal id.</dd>
            <dt id="a364ada8146a3b2a8dce5a100976ee834">
              <span class="m-doc-wrap-bumper">auto <a href="#a364ada8146a3b2a8dce5a100976ee834" class="m-doc-self">dimensions</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1size.html" class="m-doc">size</a></span>
            </dt>
            <dd>Returns the size in map cells of the referenced map.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#ab5c2bd282f2d345d936d8bbd00617222" class="m-doc">big</a>(</span><span class="m-doc-wrap">) const -&gt; bool</span>
            </dt>
            <dd>Indicates if this map is big or not.</dd>
            <dt id="a3f0bced2dce7539970194eaf582061fb">
              <span class="m-doc-wrap-bumper">auto <a href="#a3f0bced2dce7539970194eaf582061fb" class="m-doc-self">bpp</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="group__color.html#gac2f168d95746d61f442c3d3eadffc77e" class="m-doc">bpp_<wbr />mode</a></span>
            </dt>
            <dd>Returns the bits per pixel of the referenced color palette.</dd>
            <dt id="a397d70a0c80cf5c9ef2a1f99927b28be">
              <span class="m-doc-wrap-bumper">auto <a href="#a397d70a0c80cf5c9ef2a1f99927b28be" class="m-doc-self">tiles_offset</a>(</span><span class="m-doc-wrap">) const -&gt; int</span>
            </dt>
            <dd>Returns how many tiles to offset in the cells of this map before writing them in VRAM.</dd>
            <dt id="a7528742121e00d8ea9993b71847cc4dd">
              <span class="m-doc-wrap-bumper">auto <a href="#a7528742121e00d8ea9993b71847cc4dd" class="m-doc-self">palette_banks_offset</a>(</span><span class="m-doc-wrap">) const -&gt; int</span>
            </dt>
            <dd>Returns how many palette banks to offset in the cells of this map before writing them in VRAM.</dd>
            <dt id="ae684bce5bf9b3f83368f33d964915100">
              <span class="m-doc-wrap-bumper">auto <a href="#ae684bce5bf9b3f83368f33d964915100" class="m-doc-self">compression</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="group__tool.html#gabe5512b25aeba41d12da5c555ed129ae" class="m-doc">compression_<wbr />type</a></span>
            </dt>
            <dd>Returns the compression of the referenced map cells.</dd>
            <dt id="a71e392d29d0bee9f4da33e288adb1365">
              <span class="m-doc-wrap-bumper">auto <a href="#a71e392d29d0bee9f4da33e288adb1365" class="m-doc-self">cells_ref</a>(</span><span class="m-doc-wrap">) const -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1span.html" class="m-doc">span</a>&lt;const <a href="namespacebn.html#a6095e8103771dcb0c6ca117cd14a3a98" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />cell</a>&gt;&gt;</span>
            </dt>
            <dd>Returns the referenced map cells unless it was created with allocate or allocate_optional. In that case, it returns <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a>.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#aa1b0a6336e7ca6bfafb5e246021290da" class="m-doc">set_cells_ref</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item)</span>
            </dt>
            <dd>Sets the map cells to handle.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ad96cab9af6c8311bd287b0762e59932f" class="m-doc">set_cells_ref</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              int map_index)</span>
            </dt>
            <dd>Sets the map cells to handle.</dd>
            <dt id="abc8235eb4cb4a2508f4a370580fb52e2">
              <span class="m-doc-wrap-bumper">void <a href="#abc8235eb4cb4a2508f4a370580fb52e2" class="m-doc-self">reload_cells_ref</a>(</span><span class="m-doc-wrap">)</span>
            </dt>
            <dd>Uploads the referenced map cells to VRAM again to make visible the possible changes in them.</dd>
            <dt id="ade86b10cbcc46d5490d1f8c1f9994267">
              <span class="m-doc-wrap-bumper">auto <a href="#ade86b10cbcc46d5490d1f8c1f9994267" class="m-doc-self">tiles</a>(</span><span class="m-doc-wrap">) const -&gt; const <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a>&amp;</span>
            </dt>
            <dd>Returns the referenced tiles.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a41744b66921d0dd3c82b59650422014f" class="m-doc">set_tiles</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a>&amp; tiles)</span>
            </dt>
            <dd>Sets the referenced tiles.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#abc341429065d98efcf1ffb4db6f9bca0" class="m-doc">set_tiles</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a>&amp;&amp; tiles)</span>
            </dt>
            <dd>Sets the referenced tiles.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#ae1d4adab17c6c715244c689b07e7992f" class="m-doc">set_tiles</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__tiles__item.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />item</a>&amp; tiles_item)</span>
            </dt>
            <dd>Replaces the referenced tiles with a new tile set created with the given <a href="classbn_1_1regular__bg__tiles__item.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />item</a>.</dd>
            <dt id="a62233a20ba43580823b7b6d2055fc5dd">
              <span class="m-doc-wrap-bumper">auto <a href="#a62233a20ba43580823b7b6d2055fc5dd" class="m-doc-self">palette</a>(</span><span class="m-doc-wrap">) const -&gt; const <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>&amp;</span>
            </dt>
            <dd>Returns the referenced color palette.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a160655f5fb1e32e3e524faf1fcca4176" class="m-doc">set_palette</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>&amp; palette)</span>
            </dt>
            <dd>Sets the referenced color palette.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#aa8fd10872ca9211748b747b0044d601a" class="m-doc">set_palette</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>&amp;&amp; palette)</span>
            </dt>
            <dd>Sets the referenced color palette.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a9dd80555d9c99f9214efd55000b2365f" class="m-doc">set_palette</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1bg__palette__item.html" class="m-doc">bg_<wbr />palette_<wbr />item</a>&amp; palette_item)</span>
            </dt>
            <dd>Replaces the referenced color palette with a new tile set created with the given <a href="classbn_1_1bg__palette__item.html" class="m-doc">bg_<wbr />palette_<wbr />item</a>.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a70bfbdc7ddb1d54d52f086077c69ba53" class="m-doc">set_tiles_and_palette</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette)</span>
            </dt>
            <dd>Sets the tiles and the color palette to reference.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#aa2bcd492323377361ab2ea3fe85c9b5d" class="m-doc">set_tiles_and_palette</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__tiles__item.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />item</a>&amp; tiles_item,
              const <a href="classbn_1_1bg__palette__item.html" class="m-doc">bg_<wbr />palette_<wbr />item</a>&amp; palette_item)</span>
            </dt>
            <dd>Replaces the referenced tiles and color palette with the created with the given <a href="classbn_1_1regular__bg__tiles__item.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />item</a> and <a href="classbn_1_1bg__palette__item.html" class="m-doc">bg_<wbr />palette_<wbr />item</a>.</dd>
            <dt id="ad6672a6859aec426b815aa627bcc6d26">
              <span class="m-doc-wrap-bumper">auto <a href="#ad6672a6859aec426b815aa627bcc6d26" class="m-doc-self">vram</a>(</span><span class="m-doc-wrap">) -&gt; <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1span.html" class="m-doc">span</a>&lt;<a href="namespacebn.html#a6095e8103771dcb0c6ca117cd14a3a98" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />cell</a>&gt;&gt;</span>
            </dt>
            <dd>Returns the allocated memory in VRAM if this <a href="namespacebn.html#a6095e8103771dcb0c6ca117cd14a3a98" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />cell</a> was created with allocate or allocate_optional; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</dd>
            <dt id="aa6a4306cc768d710087756f84d467a41">
              <span class="m-doc-wrap-bumper">auto <a href="#aa6a4306cc768d710087756f84d467a41" class="m-doc-self">handle</a>(</span><span class="m-doc-wrap">) const -&gt; int</span>
            </dt>
            <dd>Returns the internal handle.</dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#aeab685efa50c6d5124054ede35b6cc50" class="m-doc">swap</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; other)</span>
            </dt>
            <dd>Exchanges the contents of this <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> with those of the other one.</dd>
          </dl>
        </section>
        <section id="friends">
          <h2><a href="#friends">Friends</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a4045d99abe4864f1216f6c1a09551939" class="m-doc">swap</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; a,
              <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; b)</span>
            </dt>
            <dd>Exchanges the contents of a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> with those of another one.</dd>
            <dt id="a85d08b83d0751c0e43c18a684db15340">
              <span class="m-doc-wrap-bumper">auto <a href="#a85d08b83d0751c0e43c18a684db15340" class="m-doc-self">operator==</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; a,
              const <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; b) -&gt; bool <span class="m-label m-flat m-info">defaulted</span></span>
            </dt>
            <dd>Default equal operator.</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="a2d07bec8b450dd9be1cb3fad866b2c26"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a2d07bec8b450dd9be1cb3fad866b2c26" class="m-doc-self">find</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              const <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a>&amp; tiles,
              const <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>&amp; palette)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map_item</td>
                  <td><a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a> which references the map cells to search.</td>
                </tr>
                <tr>
                  <td>tiles</td>
                  <td>Referenced tiles of the map to search.</td>
                </tr>
                <tr>
                  <td>palette</td>
                  <td>Referenced color palette of the map to search.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="afe2eaea1ee94a84f232bb51c47cfa8b3"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#afe2eaea1ee94a84f232bb51c47cfa8b3" class="m-doc-self">find</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              const <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a>&amp; tiles,
              const <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>&amp; palette,
              int map_index)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map_item</td>
                  <td><a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a> which references the map cells to search.</td>
                </tr>
                <tr>
                  <td>tiles</td>
                  <td>Referenced tiles of the map to search.</td>
                </tr>
                <tr>
                  <td>palette</td>
                  <td>Referenced color palette of the map to search.</td>
                </tr>
                <tr>
                  <td>map_index</td>
                  <td>Index of the referenced map to search.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="abca117d5579fd9a773e3d746d6b5130d"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#abca117d5579fd9a773e3d746d6b5130d" class="m-doc-self">find</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">item</td>
                  <td><a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a> which references the tiles, the color palette and the map cells to search.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="af3bb07f1f5c04d4e7559cc573b85503e"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af3bb07f1f5c04d4e7559cc573b85503e" class="m-doc-self">find</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item,
              int map_index)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">item</td>
                  <td><a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a> which references the tiles, the color palette and the map cells to search.</td>
                </tr>
                <tr>
                  <td>map_index</td>
                  <td>Index of the referenced map to search.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a949acc3cde0d9f2f342e184b3a7a792b"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a949acc3cde0d9f2f342e184b3a7a792b" class="m-doc-self">create</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map_item</td>
                  <td><a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a> which references the map cells to search or handle.</td>
                </tr>
                <tr>
                  <td>tiles</td>
                  <td>Referenced tiles of the map to search or handle.</td>
                </tr>
                <tr>
                  <td>palette</td>
                  <td>Referenced color palette of the map to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; otherwise it returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</td>
                </tr>
              </tfoot>
            </table>
<p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="ae3f7d88e00caa420a37354b4df7c2582"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae3f7d88e00caa420a37354b4df7c2582" class="m-doc-self">create</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette,
              int map_index)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map_item</td>
                  <td><a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a> which references the map cells to search or handle.</td>
                </tr>
                <tr>
                  <td>tiles</td>
                  <td>Referenced tiles of the map to search or handle.</td>
                </tr>
                <tr>
                  <td>palette</td>
                  <td>Referenced color palette of the map to search or handle.</td>
                </tr>
                <tr>
                  <td>map_index</td>
                  <td>Index of the referenced map to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; otherwise it returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</td>
                </tr>
              </tfoot>
            </table>
<p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="a0c4e8b96ccb6fe80a9765a0ec66426bb"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a0c4e8b96ccb6fe80a9765a0ec66426bb" class="m-doc-self">create</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">item</td>
                  <td><a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a> which references the tiles, the color palette and the map cells to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; otherwise it returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</td>
                </tr>
              </tfoot>
            </table>
<p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="ab7bdc14b5331988d8a5edc4aa1f6d203"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab7bdc14b5331988d8a5edc4aa1f6d203" class="m-doc-self">create</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item,
              int map_index)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">item</td>
                  <td><a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a> which references the tiles, the color palette and the map cells to search or handle.</td>
                </tr>
                <tr>
                  <td>map_index</td>
                  <td>Index of the referenced map to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; otherwise it returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</td>
                </tr>
              </tfoot>
            </table>
<p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="aba98edb02f325a515ccf26a239e2dd40"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aba98edb02f325a515ccf26a239e2dd40" class="m-doc-self">allocate</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1size.html" class="m-doc">size</a>&amp; dimensions,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette)</span></span>
            </h3>
            <p>Creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references a chunk of VRAM map cells not visible on the screen.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">dimensions</td>
                  <td>Size in map cells of the map to allocate.</td>
                </tr>
                <tr>
                  <td>tiles</td>
                  <td>Referenced tiles of the map to allocate.</td>
                </tr>
                <tr>
                  <td>palette</td>
                  <td>Referenced color palette of the map to allocate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references a chunk of VRAM map cells not visible on the screen.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a8c3cd9fc0d26dda9d0220d704c62fa98"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a8c3cd9fc0d26dda9d0220d704c62fa98" class="m-doc-self">create_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map_item</td>
                  <td><a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a> which references the map cells to search or handle.</td>
                </tr>
                <tr>
                  <td>tiles</td>
                  <td>Referenced tiles of the map to search or handle.</td>
                </tr>
                <tr>
                  <td>palette</td>
                  <td>Referenced color palette of the map to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; otherwise it returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it if the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> can be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
<p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="af34582759a7f9095ffc7bdc0b60dc0ef"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af34582759a7f9095ffc7bdc0b60dc0ef" class="m-doc-self">create_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette,
              int map_index)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map_item</td>
                  <td><a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a> which references the map cells to search or handle.</td>
                </tr>
                <tr>
                  <td>tiles</td>
                  <td>Referenced tiles of the map to search or handle.</td>
                </tr>
                <tr>
                  <td>palette</td>
                  <td>Referenced color palette of the map to search or handle.</td>
                </tr>
                <tr>
                  <td>map_index</td>
                  <td>Index of the referenced map to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; otherwise it returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it if the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> can be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
<p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="aecd9c77e22050f9c37bb93a8c9a9f0d0"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aecd9c77e22050f9c37bb93a8c9a9f0d0" class="m-doc-self">create_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">item</td>
                  <td><a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a> which references the tiles, the color palette and the map cells to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; otherwise it returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it if the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> can be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
<p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="aa542e8e72ae0cba7772ab519e58cb556"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa542e8e72ae0cba7772ab519e58cb556" class="m-doc-self">create_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a>&amp; item,
              int map_index)</span></span>
            </h3>
            <p>Searches for a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information. If it is not found, it creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">item</td>
                  <td><a href="classbn_1_1regular__bg__item.html" class="m-doc">regular_<wbr />bg_<wbr />item</a> which references the tiles, the color palette and the map cells to search or handle.</td>
                </tr>
                <tr>
                  <td>map_index</td>
                  <td>Index of the referenced map to search or handle.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references the given information if it has been found; otherwise it returns a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references it if the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> can be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
<p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="af397abc18c118f0782d8fe9e1fc2c0aa"><div>
            <h3>
              <span class="m-doc-wrap-bumper">static <a href="classbn_1_1optional.html" class="m-doc">optional</a>&lt;<a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&gt; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#af397abc18c118f0782d8fe9e1fc2c0aa" class="m-doc-self">allocate_optional</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1size.html" class="m-doc">size</a>&amp; dimensions,
              <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette)</span></span>
            </h3>
            <p>Creates a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references a chunk of VRAM map cells not visible on the screen.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">dimensions</td>
                  <td>Size in map cells of the map to allocate.</td>
                </tr>
                <tr>
                  <td>tiles</td>
                  <td>Referenced tiles of the map to allocate.</td>
                </tr>
                <tr>
                  <td>palette</td>
                  <td>Referenced color palette of the map to allocate.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> which references a chunk of VRAM map cells not visible on the screen if the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> can be allocated; <a href="namespacebn.html#a01f293535903e4c4777564a86a0f520b" class="m-doc">bn::<wbr />nullopt</a> otherwise.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="aae88f5344ccf5e4322be0eda4b5e61b2"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aae88f5344ccf5e4322be0eda4b5e61b2" class="m-doc-self">regular_bg_map_ptr</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; other)</span></span>
            </h3>
            <p>Copy constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">other</td>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to copy.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a937b2154b31edfdb959f971b8db5454f"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a937b2154b31edfdb959f971b8db5454f" class="m-doc-self">regular_bg_map_ptr</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp;&amp; other) <span class="m-label m-success">noexcept</span></span></span>
            </h3>
            <p>Move constructor.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">other</td>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to move.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="adfb755eed8e56315334d9603a490c1be"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#adfb755eed8e56315334d9603a490c1be" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; other)</span></span>
            </h3>
            <p>Copy assignment operator.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">other</td>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to copy.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="ab8b66a5272f649fd79e7821828d49a7f"><div>
            <h3>
              <span class="m-doc-wrap-bumper"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab8b66a5272f649fd79e7821828d49a7f" class="m-doc-self">operator=</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp;&amp; other) <span class="m-label m-success">noexcept</span></span></span>
            </h3>
            <p>Move assignment operator.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">other</td>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to move.</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td>Reference to this.</td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="ab5c2bd282f2d345d936d8bbd00617222"><div>
            <h3>
              <span class="m-doc-wrap-bumper">bool bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ab5c2bd282f2d345d936d8bbd00617222" class="m-doc-self">big</a>(</span><span class="m-doc-wrap">) const</span></span>
            </h3>
            <p>Indicates if this map is big or not.</p>
<p>Big backgrounds are slower CPU wise, but can have any width or height multiple of 256 pixels.</p>
          </div></section>
          <section class="m-doc-details" id="aa1b0a6336e7ca6bfafb5e246021290da"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa1b0a6336e7ca6bfafb5e246021290da" class="m-doc-self">set_cells_ref</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item)</span></span>
            </h3>
            <p>Sets the map cells to handle.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map_item</td>
                  <td><a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a> which references the map cells to set.</td>
                </tr>
              </tbody>
            </table>
<p>The map system does not support multiple <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> items referencing to the same map cells.</p><p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="ad96cab9af6c8311bd287b0762e59932f"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad96cab9af6c8311bd287b0762e59932f" class="m-doc-self">set_cells_ref</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a>&amp; map_item,
              int map_index)</span></span>
            </h3>
            <p>Sets the map cells to handle.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">map_item</td>
                  <td><a href="classbn_1_1regular__bg__map__item.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />item</a> which references the map cells to set.</td>
                </tr>
                <tr>
                  <td>map_index</td>
                  <td>Index of the referenced map to set.</td>
                </tr>
              </tbody>
            </table>
<p>The map system does not support multiple <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> items referencing to the same map cells.</p><p>The map cells are not copied but referenced, so they should outlive the <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to avoid dangling references.</p>
          </div></section>
          <section class="m-doc-details" id="a41744b66921d0dd3c82b59650422014f"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a41744b66921d0dd3c82b59650422014f" class="m-doc-self">set_tiles</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a>&amp; tiles)</span></span>
            </h3>
            <p>Sets the referenced tiles.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">tiles</td>
                  <td><a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> to copy.</td>
                </tr>
              </tbody>
            </table>
<p>It must be compatible with the referenced color palette.</p>
          </div></section>
          <section class="m-doc-details" id="abc341429065d98efcf1ffb4db6f9bca0"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#abc341429065d98efcf1ffb4db6f9bca0" class="m-doc-self">set_tiles</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a>&amp;&amp; tiles)</span></span>
            </h3>
            <p>Sets the referenced tiles.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">tiles</td>
                  <td><a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> to move.</td>
                </tr>
              </tbody>
            </table>
<p>It must be compatible with the referenced color palette.</p>
          </div></section>
          <section class="m-doc-details" id="ae1d4adab17c6c715244c689b07e7992f"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ae1d4adab17c6c715244c689b07e7992f" class="m-doc-self">set_tiles</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__tiles__item.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />item</a>&amp; tiles_item)</span></span>
            </h3>
            <p>Replaces the referenced tiles with a new tile set created with the given <a href="classbn_1_1regular__bg__tiles__item.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />item</a>.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">tiles_item</td>
                  <td>It creates the new background tiles to reference.</td>
                </tr>
              </tbody>
            </table>
<p>Before creating a new background tile set, the <a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> referenced by this map is removed, so VRAM usage is reduced.</p><p>The new background tiles must be compatible with the referenced color palette.</p>
          </div></section>
          <section class="m-doc-details" id="a160655f5fb1e32e3e524faf1fcca4176"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a160655f5fb1e32e3e524faf1fcca4176" class="m-doc-self">set_palette</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>&amp; palette)</span></span>
            </h3>
            <p>Sets the referenced color palette.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">palette</td>
                  <td><a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> to copy.</td>
                </tr>
              </tbody>
            </table>
<p>It must be compatible with the referenced tiles.</p>
          </div></section>
          <section class="m-doc-details" id="aa8fd10872ca9211748b747b0044d601a"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa8fd10872ca9211748b747b0044d601a" class="m-doc-self">set_palette</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a>&amp;&amp; palette)</span></span>
            </h3>
            <p>Sets the referenced color palette.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">palette</td>
                  <td><a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> to move.</td>
                </tr>
              </tbody>
            </table>
<p>It must be compatible with the referenced tiles.</p>
          </div></section>
          <section class="m-doc-details" id="a9dd80555d9c99f9214efd55000b2365f"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a9dd80555d9c99f9214efd55000b2365f" class="m-doc-self">set_palette</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1bg__palette__item.html" class="m-doc">bg_<wbr />palette_<wbr />item</a>&amp; palette_item)</span></span>
            </h3>
            <p>Replaces the referenced color palette with a new tile set created with the given <a href="classbn_1_1bg__palette__item.html" class="m-doc">bg_<wbr />palette_<wbr />item</a>.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">palette_item</td>
                  <td>It creates the new color palette to reference.</td>
                </tr>
              </tbody>
            </table>
<p>Before creating a new color palette, the <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> referenced by this map is removed, so VRAM usage is reduced.</p><p>The new color palette must be compatible with the referenced tiles.</p>
          </div></section>
          <section class="m-doc-details" id="a70bfbdc7ddb1d54d52f086077c69ba53"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a70bfbdc7ddb1d54d52f086077c69ba53" class="m-doc-self">set_tiles_and_palette</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> tiles,
              <a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> palette)</span></span>
            </h3>
            <p>Sets the tiles and the color palette to reference.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">tiles</td>
                  <td><a href="classbn_1_1regular__bg__tiles__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />ptr</a> to reference.</td>
                </tr>
                <tr>
                  <td>palette</td>
                  <td><a href="classbn_1_1bg__palette__ptr.html" class="m-doc">bg_<wbr />palette_<wbr />ptr</a> to reference.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="aa2bcd492323377361ab2ea3fe85c9b5d"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aa2bcd492323377361ab2ea3fe85c9b5d" class="m-doc-self">set_tiles_and_palette</a>(</span><span class="m-doc-wrap">const <a href="classbn_1_1regular__bg__tiles__item.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />item</a>&amp; tiles_item,
              const <a href="classbn_1_1bg__palette__item.html" class="m-doc">bg_<wbr />palette_<wbr />item</a>&amp; palette_item)</span></span>
            </h3>
            <p>Replaces the referenced tiles and color palette with the created with the given <a href="classbn_1_1regular__bg__tiles__item.html" class="m-doc">regular_<wbr />bg_<wbr />tiles_<wbr />item</a> and <a href="classbn_1_1bg__palette__item.html" class="m-doc">bg_<wbr />palette_<wbr />item</a>.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">tiles_item</td>
                  <td>It creates the new background tiles to reference.</td>
                </tr>
                <tr>
                  <td>palette_item</td>
                  <td>It creates the color palette to reference.</td>
                </tr>
              </tbody>
            </table>
<p>Before creating new resources, the resources referenced by this map are removed, so VRAM usage is reduced.</p>
          </div></section>
          <section class="m-doc-details" id="aeab685efa50c6d5124054ede35b6cc50"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void bn::<wbr />regular_bg_map_ptr::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aeab685efa50c6d5124054ede35b6cc50" class="m-doc-self">swap</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; other)</span></span>
            </h3>
            <p>Exchanges the contents of this <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> with those of the other one.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">other</td>
                  <td><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to exchange the contents with.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a4045d99abe4864f1216f6c1a09551939"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void </span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a4045d99abe4864f1216f6c1a09551939" class="m-doc-self">swap</a>(</span><span class="m-doc-wrap"><a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; a,
              <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a>&amp; b)</span></span>
            </h3>
            <p>Exchanges the contents of a <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> with those of another one.</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">a</td>
                  <td>First <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to exchange the contents with.</td>
                </tr>
                <tr>
                  <td>b</td>
                  <td>Second <a href="classbn_1_1regular__bg__map__ptr.html" class="m-doc">regular_<wbr />bg_<wbr />map_<wbr />ptr</a> to exchange the contents with.</td>
                </tr>
              </tbody>
            </table>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Butano Docs. Created with <a href="https://doxygen.org/">Doxygen</a> 1.14.0 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
